Title Banner

Previous Book Contents Book Index Next

Inside Macintosh: OpenDoc Class Reference /
Part 1 - Classes and Methods / ODValueIterator


First

The First method begins the iteration and obtains the first entry in the name space.

void First (out ODISOStr key, 
            out ODByteArray value);
key
A pointer to an ISO string representing the key in the first entry in the name space, or kODNULL for an empty name space.
value
A byte array whose buffer contains the value for the first entry in the name space.
DISCUSSION
Your part must call this method before calling this value iterator's IsNotComplete method for the first time. This method may be called multiple times; each time resets the iteration.

It is your responsibility to deallocate the ISO string and byte array structure (and its buffer) when they are no longer needed. You must also delete the key when it is no longer needed.

EXCEPTIONS
kODErrIteratorOutOfSync
The name space was modified while the iteration was in progress.
SEE ALSO
The ODByteArray type (page 877).
The ODISOStr type (page 875).


Previous Book Contents Book Index Next

© Apple Computer, Inc.
17 JUL 1996




Navigation graphic, see text links

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help